社内で行ったビジネスライティング講座資料を公開します

オペレーション部　江口です。

先日、社内でビジネスライティングについてオンラインで講義する機会があったので、その資料を公開しておきたいと思います。

いわゆる技術文書というよりは、メールやSlackなど、相手とやり取りを行う際の文章作成を主に考えた資料となっていますので、その点ご承知おきください。

背景

講義を行ったのは、アカウント周りの作業を行うアカウントチームに対してでした。チームの業務内でメールでの顧客とのやり取りやSlackでの社内でのコミュニケーションなど、文章を作成する機会が多く、その際の書き方に課題を感じている方が多いようだったので、少しでも助けになればと思いこの講座を企画しました。

私は別に人に自慢できるほど文章がうまいわけではないですが、約20年のエンジニアのキャリアで顧客とのやり取りや技術文書の作成などをそこそこの数こなしてきました。先輩や上司などからいろいろな指摘を貰いながら得てきたノウハウもあるので、少しでも参考にしてもらえれば、と思った次第です。

なお「ライティング講座を開く」という話を社内でしたときに、複数名の方から「動画で写りをよくするための照明の使い方の講座かと思った」という反応をもらいました。うちの会社の人動画への興味強すぎませんか。 それはそれで面白そうなので誰かやるといいと思います。

スライドに関する補足

以下、スライドに関する補足を少し書いておきます。

概念的な話について

前半は概念的な話として、ざっくりと記号論にもとづいて、コードやコンテクストについて説明をしています。

自己紹介スライドに記載のとおり私はもともと文学部出身で、ここで書いている話は大学のときに受けた文学についての講義をベースに書いているのですが、私の専攻は史学科だったので正直なところ理解はかなり大ざっぱです。 なので、いちおう文学を専攻していた私の兄に資料を見せてレビューをもらったりしました。

コンテクスト

いちばん話したかったのはコンテクストのところです。「文そのものには書いていないけど、前提・背景として参照される（＝分かっている前提となっている）」情報ですね。

ここに書き手と読み手でズレがあると、書き手の意図がうまく伝わらない可能性があります。 これをケアせず「自分の言っていることを相手が分かってくれない！」となるのは悲しいので、相手の知らない可能性がある情報をなるべく共有しておく（文章に入れ込む、情報へのリンクを貼るなど）ということを意識しておくといいと思います。

もちろん、なんでもかんでも書かなければいけないというわけではありません。 （あまりいろいろ書きすぎると長すぎてそもそも読んでもらえない、という問題も出てきますし・・・） 読み手を信頼し、「この程度は書かなくとも伝わるだろう」と思えることは省略しても問題ないでしょう。

具体的な話

このパートで書いていることは、よく文章を書く際の基本として挙げられることなのかなと思います。

文章を構造的に書く、というのは私も苦手で、よく以前の上司から指摘をされていました （いまでもマスターできたと言えるかはあやしいものです）。

そして構造的に書く訓練として、なるべく箇条書きで書いてみることを勧められました。そのためいまも意識して箇条書きを多用しています。じっさい、箇条書きで書いてみるとすっきり書けることが多いので、文章が長くてわかりにくいとよく言われる・・・という方は意識してみることをおすすめします。

（と、ここまで書いてこのブログではぜんぜん箇条書きしてないな・・・と思いました。まあ見出しで構造化しているので・・・）

付け加えると、箇条書きも項目が多すぎると読みにくくなります。そういう場合、スライドでも紹介している階層化も使えますし、もう1つ「表に整理してみる」という手もあります。それぞれの項目について、書くべきことが多いような場合には、表にしてみると読みやすくなることがあるので検討してみましょう。画像が使えるならば図に起こしてみるのも良いアプローチです。

その他TIPSについて

字面の「白さ」

「その他のTIPS」の章に書いた『字面の「白さ」を考慮する』という点は、日本語ならではの配慮で、めちゃくちゃ気にすることでもないかなあとも思います。ただ、漢字が多すぎるとどうしても硬いイメージの文章になってしまうので、読みやすい文章と印象づけるには少し「白さの多い」（ ＝ひらがなが多い）くらいがいいかなあと思います。

段落が適度に区切られている、というのも「読みやすい印象を与える」にはポイントかなと思います。あまり短文で段落が区切られているとスカスカ感が出てしまいますが。

文章校正ツール

「日本語の校正」のスライドで紹介していますが、私はVS Codeに「テキスト校正くん」というプラグインを入れて使っています。この原稿もこのプラグインによる校正を受けながら書いています。

このプラグインに限らず、お使いのエディターに文章の校正ツールを入れておくと便利なのでおすすめです。なかなか口うるさいなと思うことも多いのですが、指摘を受けて見直すことで、すっきりした文章になったなーと思えることもまた多いです。

メディアによる違い

メディアによって文章の書き方は変わるので、それを説明するスライドを作って入れてみました。たとえばSlackは長い文章を書くには適していませんが、その代わり相手からのフィードバックがすぐに得られます。なので、前提や背景などをそこまでがっつり書かず、相手からのフィードバックを得て補足する、ということができるでしょう。

いっぽうナレッジベース（当社ではAtrassianのConfluenceを利用しています）は、ページにコメントを残せたりするものの、おおむね書き手から読み手への一方通行の文書になります。そのため、後から読む人のために前提や背景について厚めに書いたほうがよいでしょう。

当たり前の話ではあるのですが、あらためて違いをまとめてみると、見る人によっては気づきがあるかもしれません。実際、このスライドが参考になったというフィードバックがありました。

練習課題

講義をした際は、スライド中に表示した「読みにくい文章」を直してみる、というのを最後に練習課題として提示してみました。

やりたい方がいればどうぞ、くらいのテンションでお願いしたのですが、みなさん後で実践してみて、社内のSlack上で提出してくださいました。みなさんまじめに取り組んでくれたのだなあと感動しました。ありがとうございます！

感想

差し出がましくもライティング講座をやらせてもらったわけなのですが、内心「役に立つと思ってもらえるだろうか」という不安はありました。しかし、終わったあとに「文章を書くことに対するモチベーションが上がった」といった声をいただいて、チーム内の定型文の見直しなどの取り組みにもつながったとのことで、良かったなあと安堵しています。この記事を読んでいる方に対しても、少しでもお役に立てば幸いです。

以上、ライティング講座のスライドのご紹介でした！

おまけ：参考情報

このスライドで紹介している文章作成の心得はごく基本でしかありませんので、もっと文章作成に関する情報を知りたい、という方のためにいくつか参考のリンクをご紹介しておきます。

• 岩本ゼミにおけるレポート・論文の書式の基本ルール｜関大岩本ゼミのアドミン｜note
  • 講義終了後、同僚の方から参考情報として頂いたリンクです。論文・レポートの書き方の基本ルールですが、もちろん他の場面でも通用するルールだと思います。
• ドキュメント作成スキル向上を目指す人向けおすすめ記事まとめ - Qiita
  • ちょうどこの資料を書いているときにバズっていたQiitaの記事です。おもに技術者向けに、ドキュメント作成に役立つリンクが多数まとめられています。
• Technical Writing  |  Google Developers
  • Googleのテクニカルライティングに関するオンラインコースです。英語ですが、よくまとまっています。初級編である「Technical Writing One」は、英文法の基礎から始まり、用語の使い方、文章のルール、段落の使い方など基礎をじっくり解説していて非常に勉強になります。